<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::BodyPartByCell Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_body_part_by_cell.html">BodyPartByCell</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-types">Protected Types</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_s_p_h_1_1_body_part_by_cell-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::BodyPartByCell Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>An auxillary class for <a class="el" href="class_s_p_h_1_1_s_p_h_body.html" title="SPHBody is a base body with basic data and functions. Its derived class can be a real fluid body,...">SPHBody</a> to indicate a part of the body fixed in space defined by mesh cells.  
 <a href="class_s_p_h_1_1_body_part_by_cell.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="base__body_8h_source.html">base_body.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="class_s_p_h_1_1_body_part_by_shape.html">SPH::BodyPartByShape</a>.</p>

<p>Inherited by <a class="el" href="class_s_p_h_1_1_near_shape_surface.html">SPH::NearShapeSurface</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac63ee7e048a85e1b1160d172ea16460f"><td class="memItemLeft" align="right" valign="top"><a id="ac63ee7e048a85e1b1160d172ea16460f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BodyPartByCell</b> (<a class="el" href="class_s_p_h_1_1_real_body.html">RealBody</a> *real_body, std::string body_part_name)</td></tr>
<tr class="separator:ac63ee7e048a85e1b1160d172ea16460f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_s_p_h_1_1_body_part_by_shape"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_p_h_1_1_body_part_by_shape')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_s_p_h_1_1_body_part_by_shape.html">SPH::BodyPartByShape</a></td></tr>
<tr class="memitem:aa9e954a83df6dc75b1b2557b3c30a27d inherit pub_methods_class_s_p_h_1_1_body_part_by_shape"><td class="memItemLeft" align="right" valign="top"><a id="aa9e954a83df6dc75b1b2557b3c30a27d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BodyPartByShape</b> (<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *body, std::string body_part_name)</td></tr>
<tr class="separator:aa9e954a83df6dc75b1b2557b3c30a27d inherit pub_methods_class_s_p_h_1_1_body_part_by_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac859eeefeefe1857cb99313919320194 inherit pub_methods_class_s_p_h_1_1_body_part_by_shape"><td class="memItemLeft" align="right" valign="top"><a id="ac859eeefeefe1857cb99313919320194"></a>
<a class="el" href="class_s_p_h_1_1_complex_shape.html">ComplexShape</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>getBodyPartShape</b> ()</td></tr>
<tr class="separator:ac859eeefeefe1857cb99313919320194 inherit pub_methods_class_s_p_h_1_1_body_part_by_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafe9f3d56314efaf2b0463af06ebb665 inherit pub_methods_class_s_p_h_1_1_body_part_by_shape"><td class="memItemLeft" align="right" valign="top"><a id="aafe9f3d56314efaf2b0463af06ebb665"></a>
<a class="el" href="namespace_s_p_h.html#ad185cdeb05bdee76bf975cc50f1c15b7">BoundingBox</a>&#160;</td><td class="memItemRight" valign="bottom"><b>BodyPartBounds</b> ()</td></tr>
<tr class="separator:aafe9f3d56314efaf2b0463af06ebb665 inherit pub_methods_class_s_p_h_1_1_body_part_by_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_s_p_h_1_1_body_part"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_p_h_1_1_body_part')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_s_p_h_1_1_body_part.html">SPH::BodyPart</a></td></tr>
<tr class="memitem:a112440b69962f5c93fc9b2e92285d81c inherit pub_methods_class_s_p_h_1_1_body_part"><td class="memItemLeft" align="right" valign="top"><a id="a112440b69962f5c93fc9b2e92285d81c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BodyPart</b> (<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *body, std::string body_part_name)</td></tr>
<tr class="separator:a112440b69962f5c93fc9b2e92285d81c inherit pub_methods_class_s_p_h_1_1_body_part"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaca3bfadd76686d78e67b67e7f79fbec inherit pub_methods_class_s_p_h_1_1_body_part"><td class="memItemLeft" align="right" valign="top"><a id="aaca3bfadd76686d78e67b67e7f79fbec"></a>
<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>getBody</b> ()</td></tr>
<tr class="separator:aaca3bfadd76686d78e67b67e7f79fbec inherit pub_methods_class_s_p_h_1_1_body_part"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ebf55521b03c9e172af6b80de4b4d4e inherit pub_methods_class_s_p_h_1_1_body_part"><td class="memItemLeft" align="right" valign="top"><a id="a7ebf55521b03c9e172af6b80de4b4d4e"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>BodyPartName</b> ()</td></tr>
<tr class="separator:a7ebf55521b03c9e172af6b80de4b4d4e inherit pub_methods_class_s_p_h_1_1_body_part"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a4d05ac7eea923c9f08f7a6ebdfcdc1f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_s_p_h.html#a54f9b375e654fcf04192f5a123495808">CellLists</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_body_part_by_cell.html#a4d05ac7eea923c9f08f7a6ebdfcdc1f8">body_part_cells_</a></td></tr>
<tr class="separator:a4d05ac7eea923c9f08f7a6ebdfcdc1f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:aeb9ec6d0c9068ade1ebd9a15c8efb061"><td class="memItemLeft" align="right" valign="top"><a id="aeb9ec6d0c9068ade1ebd9a15c8efb061"></a>
typedef std::function&lt; <a class="el" href="classbool.html">bool</a>(Vecd, Real)&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>CheckIncludedFunctor</b></td></tr>
<tr class="separator:aeb9ec6d0c9068ade1ebd9a15c8efb061"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a96451e7974c76d32a202b7c1124a3ec5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_body_part_by_cell.html#a96451e7974c76d32a202b7c1124a3ec5">checkIncluded</a> (Vecd cell_position, Real threshold)</td></tr>
<tr class="separator:a96451e7974c76d32a202b7c1124a3ec5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab320e89b68e0120938535243bfea88da"><td class="memItemLeft" align="right" valign="top"><a id="ab320e89b68e0120938535243bfea88da"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>tagBodyPart</b> () override</td></tr>
<tr class="separator:ab320e89b68e0120938535243bfea88da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a2a049e1da3d15f3d3619205f605cd9f2"><td class="memItemLeft" align="right" valign="top"><a id="a2a049e1da3d15f3d3619205f605cd9f2"></a>
<a class="el" href="class_s_p_h_1_1_real_body.html">RealBody</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>real_body_</b></td></tr>
<tr class="separator:a2a049e1da3d15f3d3619205f605cd9f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa487cc8f2c166818c57f4c9eb4fb5a37"><td class="memItemLeft" align="right" valign="top"><a id="aa487cc8f2c166818c57f4c9eb4fb5a37"></a>
CheckIncludedFunctor&#160;</td><td class="memItemRight" valign="bottom"><b>checkIncluded_</b></td></tr>
<tr class="separator:aa487cc8f2c166818c57f4c9eb4fb5a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_s_p_h_1_1_body_part_by_shape"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_s_p_h_1_1_body_part_by_shape')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_s_p_h_1_1_body_part_by_shape.html">SPH::BodyPartByShape</a></td></tr>
<tr class="memitem:ab65414719623ee281ae1a8d31144b0bd inherit pro_attribs_class_s_p_h_1_1_body_part_by_shape"><td class="memItemLeft" align="right" valign="top"><a id="ab65414719623ee281ae1a8d31144b0bd"></a>
<a class="el" href="class_s_p_h_1_1_complex_shape.html">ComplexShape</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>body_part_shape_</b></td></tr>
<tr class="separator:ab65414719623ee281ae1a8d31144b0bd inherit pro_attribs_class_s_p_h_1_1_body_part_by_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_s_p_h_1_1_body_part"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_s_p_h_1_1_body_part')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_s_p_h_1_1_body_part.html">SPH::BodyPart</a></td></tr>
<tr class="memitem:a092916531f2808352e38ef9208326792 inherit pro_attribs_class_s_p_h_1_1_body_part"><td class="memItemLeft" align="right" valign="top"><a id="a092916531f2808352e38ef9208326792"></a>
<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>body_</b></td></tr>
<tr class="separator:a092916531f2808352e38ef9208326792 inherit pro_attribs_class_s_p_h_1_1_body_part"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8643053b682dceb0e3c0a7003d8e81d8 inherit pro_attribs_class_s_p_h_1_1_body_part"><td class="memItemLeft" align="right" valign="top"><a id="a8643053b682dceb0e3c0a7003d8e81d8"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>body_part_name_</b></td></tr>
<tr class="separator:a8643053b682dceb0e3c0a7003d8e81d8 inherit pro_attribs_class_s_p_h_1_1_body_part"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An auxillary class for <a class="el" href="class_s_p_h_1_1_s_p_h_body.html" title="SPHBody is a base body with basic data and functions. Its derived class can be a real fluid body,...">SPHBody</a> to indicate a part of the body fixed in space defined by mesh cells. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a96451e7974c76d32a202b7c1124a3ec5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96451e7974c76d32a202b7c1124a3ec5">&#9670;&nbsp;</a></span>checkIncluded()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbool.html">bool</a> SPH::BodyPartByCell::checkIncluded </td>
          <td>(</td>
          <td class="paramtype">Vecd&#160;</td>
          <td class="paramname"><em>cell_position</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>threshold</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>all cells near or contained by the body part shape are included </p>

<p>Reimplemented in <a class="el" href="class_s_p_h_1_1_near_shape_surface.html#a955c3c8dd94aa0d19ddf8ade8fa9d464">SPH::NearShapeSurface</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a4d05ac7eea923c9f08f7a6ebdfcdc1f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d05ac7eea923c9f08f7a6ebdfcdc1f8">&#9670;&nbsp;</a></span>body_part_cells_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespace_s_p_h.html#a54f9b375e654fcf04192f5a123495808">CellLists</a> SPH::BodyPartByCell::body_part_cells_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Collection of cells to indicate the body part. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>SPHINXsys/src/shared/bodies/<a class="el" href="base__body_8h_source.html">base_body.h</a></li>
<li>SPHINXsys/src/shared/bodies/<a class="el" href="base__body_8cpp.html">base_body.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
